{ "openapi": "3.0.3", "info": { "title": "Certificates", "description": "X.509 certificate chains with intermediate and root CA support. Trusted CA list bundles for client authentication and mTLS validation. CRL distribution points and OCSP stapling configuration. Certificate manifests link credentials to load balancers and gateways. Automatic expiration tracking and renewal notifications.", "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": "X.509 certificate chains with intermediate and root CA support. Trusted CA list bundles for client authentication and mTLS validation. CRL distribution points and OCSP stapling configuration. Certificate manifests link credentials to load balancers and gateways. Automatic expiration tracking and renewal notifications.", "x-f5xc-summary": "Certificate chains and trusted CA bundles. Revocation list management and manifest configuration for PKI operations.", "x-f5xc-cli-domain": "certificates", "externalDocs": { "url": "https://docs.cloud.f5.com/docs/how-to/app-security/tls-certificates", "description": "F5 XC Documentation - Certificate Management" }, "x-f5xc-api-reference-url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/", "x-f5xc-best-practices": { "common_errors": [ { "code": 400, "message": "Certificate chain incomplete", "resolution": "Include intermediate certificates in chain", "prevention": "Validate certificate chain before upload" }, { "code": 400, "message": "Private key mismatch", "resolution": "Ensure private key matches certificate", "prevention": "Verify key-cert pair before upload" }, { "code": 400, "message": "Certificate expired", "resolution": "Renew certificate and upload new version", "prevention": "Set up certificate expiry monitoring" } ], "security_notes": [ "Use certificates with at least 2048-bit RSA or 256-bit ECDSA keys", "Enable OCSP stapling for revocation checking", "Configure certificate transparency logging", "Use separate certificates for different environments" ], "performance_tips": [ "Use ECDSA certificates for faster TLS handshakes", "Enable session resumption for repeat visitors", "Configure OCSP stapling to reduce client latency" ] }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "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" } ], "paths": { "/api/config/namespaces/{metadata.namespace}/crls": { "post": { "summary": "Create CRL.", "description": "API to create CRL object.", "operationId": "ves.io.schema.crl.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/crlCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/crlCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.crl.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Crl resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "crl" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "crl" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CRL", "x-ves-proto-service": "ves.io.schema.crl.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/crls/{metadata.name}": { "put": { "summary": "Replace CRL.", "description": "API to replace CRL object.", "operationId": "ves.io.schema.crl.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/crlReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/crlReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.crl.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "crl" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "crl" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CRL", "x-ves-proto-service": "ves.io.schema.crl.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/crls": { "get": { "summary": "List CRL", "description": "List the set of CRL in a namespace.", "operationId": "ves.io.schema.crl.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/crlListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 CRL.", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.crl.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CRL", "x-ves-proto-service": "ves.io.schema.crl.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/crls/{name}": { "get": { "summary": "GET CRL", "description": "API to GET CRL.", "operationId": "ves.io.schema.crl.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/crlGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.crl.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE CRL.", "description": "DELETE the specified CRL.", "operationId": "ves.io.schema.crl.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/crlDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.crl.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "crl", "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": [ "crl", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "CRL", "x-ves-proto-service": "ves.io.schema.crl.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/certificates": { "post": { "summary": "Create Certificate.", "description": "Shape of the Certificate specification.", "operationId": "ves.io.schema.certificate.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificateCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/certificateCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate for secure connections", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Certificate resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "certificate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "certificate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Certificate.", "x-ves-proto-service": "ves.io.schema.certificate.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/certificates/{metadata.name}": { "put": { "summary": "Replace Certificate.", "description": "Shape of the Certificate specification.", "operationId": "ves.io.schema.certificate.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificateReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/certificateReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate for secure connections", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "certificate" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "certificate" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Certificate.", "x-ves-proto-service": "ves.io.schema.certificate.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/certificates": { "get": { "summary": "List Certificate.", "description": "List the set of certificate in a namespace.", "operationId": "ves.io.schema.certificate.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificateListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 certificate.", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate for secure connections", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 159.59, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 159.59, "p95_ms": 319.18, "p99_ms": 478.77, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Certificate.", "x-ves-proto-service": "ves.io.schema.certificate.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/certificates/{name}": { "get": { "summary": "GET Certificate.", "description": "Shape of the Certificate specification.", "operationId": "ves.io.schema.certificate.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificateGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate for secure connections", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.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 Certificate.", "description": "DELETE the specified certificate.", "operationId": "ves.io.schema.certificate.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/certificateDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate for secure connections", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "certificate", "contained_resources" ] }, "danger_level": "high", "confirmation_required": true, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "high", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "high", "x-f5xc-confirmation-required": true, "x-f5xc-side-effects": { "deletes": [ "certificate", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Certificate.", "x-ves-proto-service": "ves.io.schema.certificate.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/certificate_chains": { "post": { "summary": "Create Certificate Chain.", "description": "Shape of the Certificate Chain specification.", "operationId": "ves.io.schema.certificate_chain.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificate_chainCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/certificate_chainCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate_chain.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Certificate-chain resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "certificate-chain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "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": [ "certificate-chain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Certificate Chain.", "x-ves-proto-service": "ves.io.schema.certificate_chain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/certificate_chains/{metadata.name}": { "put": { "summary": "Replace Certificate Chain.", "description": "Shape of the Certificate Chain specification.", "operationId": "ves.io.schema.certificate_chain.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificate_chainReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/certificate_chainReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate_chain.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "certificate-chain" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying 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": [ "certificate-chain" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Certificate Chain.", "x-ves-proto-service": "ves.io.schema.certificate_chain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/certificate_chains": { "get": { "summary": "List Certificate Chain.", "description": "List the set of certificate_chain in a namespace.", "operationId": "ves.io.schema.certificate_chain.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificate_chainListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 certificate_chain.", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate_chain.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-discovered-response-time-ms": 152.78, "x-discovered-sample-size": 1, "x-f5xc-discovered-response-time": { "p50_ms": 152.78, "p95_ms": 305.56, "p99_ms": 458.34, "sample_count": 1, "source": "discovery", "last_measured": "2025-12-20T19:39:20.211392+00:00" } }, "x-displayname": "Certificate Chain.", "x-ves-proto-service": "ves.io.schema.certificate_chain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/certificate_chains/{name}": { "get": { "summary": "GET Certificate Chain.", "description": "Shape of the Certificate Chain specification.", "operationId": "ves.io.schema.certificate_chain.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificate_chainGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate_chain.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.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 Certificate Chain.", "description": "DELETE the specified certificate_chain.", "operationId": "ves.io.schema.certificate_chain.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/certificate_chainDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.certificate_chain.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "TLS/SSL certificate management", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace", "Certificate file or data" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "certificate-chain", "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": [ "certificate-chain", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Certificate Chain.", "x-ves-proto-service": "ves.io.schema.certificate_chain.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/trusted_ca_lists": { "post": { "summary": "Create Root CA Certificate.", "description": "Shape of the Root CA Certificate specification.", "operationId": "ves.io.schema.trusted_ca_list.API.Create", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_ca_listCreateResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/trusted_ca_listCreateRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.trusted_ca_list.API.Create", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource creation operation", "required_fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Trusted-ca-list resource created", "Resource assigned unique identifier" ] }, "side_effects": { "creates": [ "trusted-ca-list" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "metadata.name", "metadata.namespace", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "creates": [ "trusted-ca-list" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 1000, "p95_ms": 3000, "p99_ms": 8000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Root CA Certificate.", "x-ves-proto-service": "ves.io.schema.trusted_ca_list.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{metadata.namespace}/trusted_ca_lists/{metadata.name}": { "put": { "summary": "Replace Root CA Certificate.", "description": "Shape of the Root CA Certificate specification.", "operationId": "ves.io.schema.trusted_ca_list.API.Replace", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_ca_listReplaceResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "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/trusted_ca_listReplaceRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.trusted_ca_list.API.Replace", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource replacement operation", "required_fields": [ "path.metadata.name", "path.metadata.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource updated with new values" ] }, "side_effects": { "modifies": [ "trusted-ca-list" ] }, "danger_level": "medium", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.metadata.name", "path.metadata.namespace" ], "x-f5xc-danger-level": "medium", "x-f5xc-side-effects": { "modifies": [ "trusted-ca-list" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 800, "p95_ms": 2500, "p99_ms": 6000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Root CA Certificate.", "x-ves-proto-service": "ves.io.schema.trusted_ca_list.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/trusted_ca_lists": { "get": { "summary": "List Root CA Certificate.", "description": "List the set of trusted_ca_list in a namespace.", "operationId": "ves.io.schema.trusted_ca_list.API.List", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_ca_listListResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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 trusted_ca_list.", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.trusted_ca_list.API.List", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "moderate", "resource_usage": "moderate" } }, "x-f5xc-required-fields": [ "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Root CA Certificate.", "x-ves-proto-service": "ves.io.schema.trusted_ca_list.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" }, "/api/config/namespaces/{namespace}/trusted_ca_lists/{name}": { "get": { "summary": "GET Root CA Certificate.", "description": "Shape of the Root CA Certificate specification.", "operationId": "ves.io.schema.trusted_ca_list.API.Get", "responses": { "200": { "description": "A successful response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trusted_ca_listGetResponse" } } } }, "401": { "description": "Returned when operation is not authorized.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "403": { "description": "Returned when there is no permission to access resource.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "404": { "description": "Returned when resource is not found.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "409": { "description": "Returned when operation on resource is conflicting with current value.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "429": { "description": "Returned when operation has been rejected as it is happening too frequently.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "500": { "description": "Returned when server encountered an error in processing API.", "content": { "application/json": { "schema": { "type": "string", "format": "string" } } } }, "503": { "description": "Returned when service is unavailable temporarily.", "content": { "application/json": { "schema": { "type": "string", "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/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.trusted_ca_list.API.Get", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource retrieval operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [] }, "side_effects": {}, "danger_level": "low", "confirmation_required": false, "common_errors": [ { "code": 401, "message": "Authentication required", "solution": "Provide valid API credentials" }, { "code": 403, "message": "Permission denied", "solution": "Check access permissions for this operation" }, { "code": 404, "message": "Resource not found", "solution": "Verify resource name, namespace, and path" }, { "code": 409, "message": "Resource already exists", "solution": "Use different name or update existing resource" }, { "code": 429, "message": "Rate limit exceeded", "solution": "Wait before retrying the operation" }, { "code": 500, "message": "Server error", "solution": "Retry operation or contact support" } ], "performance_impact": { "latency": "low", "resource_usage": "low" } }, "x-f5xc-required-fields": [ "path.name", "path.namespace" ], "x-f5xc-danger-level": "low", "x-f5xc-discovered-response-time": { "p50_ms": 200, "p95_ms": 800, "p99_ms": 2000, "sample_count": 0, "source": "estimate" } }, "delete": { "summary": "DELETE Root CA Certificate.", "description": "DELETE the specified trusted_ca_list.", "operationId": "ves.io.schema.trusted_ca_list.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/trusted_ca_listDeleteRequest" } } }, "required": true }, "externalDocs": { "description": "Examples of this operation.", "url": "https://f5-sales-demo.github.io/api-specs-enriched/api-reference/certificates/" }, "x-ves-proto-rpc": "ves.io.schema.trusted_ca_list.API.Delete", "tags": [ "config" ], "x-f5xc-operation-metadata": { "purpose": "Resource deletion operation", "required_fields": [ "path.name", "path.namespace" ], "optional_fields": [], "field_docs": {}, "conditions": { "prerequisites": [ "Active namespace" ], "postconditions": [ "Resource removed from system", "Associated resources may be affected" ] }, "side_effects": { "deletes": [ "trusted-ca-list", "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": [ "trusted-ca-list", "contained_resources" ] }, "x-f5xc-discovered-response-time": { "p50_ms": 500, "p95_ms": 1500, "p99_ms": 4000, "sample_count": 0, "source": "estimate" } }, "x-displayname": "Root CA Certificate.", "x-ves-proto-service": "ves.io.schema.trusted_ca_list.API", "x-ves-proto-service-type": "AUTO_CRUD_PUBLIC" } }, "components": { "securitySchemes": { "ApiToken": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "API Token authentication. Format: 'APIToken '" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "F5 XC API Token (format: APIToken )" } }, "schemas": { "crlCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of crl", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.crl.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/crlCreateSpecType" } ], "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 crlCreateRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.crl.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/crlGetSpecType" } ], "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 crlCreateResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlCreateSpecType": { "type": "object", "description": "API to create CRL object.", "title": "Create CRL", "x-displayname": "Create CRL.", "x-ves-oneof-field-access_info_choice": "[\"http_access\"]", "x-ves-proto-message": "ves.io.schema.crl.CreateSpecType", "properties": { "http_access": { "allOf": [ { "$ref": "#/components/schemas/crlHTTPAccessInfo" } ], "x-f5xc-description-short": "Configuration parameter for http access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "refresh_interval": { "type": "integer", "description": "CRL refresh interval, in hours.", "format": "int64", "x-displayname": "CRL Refresh interval.", "x-ves-example": "24", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "6", "ves.io.schema.rules.uint32.lte": "168" }, "x-f5xc-example": "24", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "6", "ves.io.schema.rules.uint32.lte": "168" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 6, "maximum": 168, "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 } }, "server_address": { "type": "string", "description": "CRL server address or hostname.", "maxLength": 255, "x-displayname": "CRL Server address.", "x-ves-example": "example-crl.it.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname_or_ip": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-example": "example-crl.it.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname_or_ip": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "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 } }, "server_port": { "type": "integer", "description": "Set CRL Server port number.", "format": "int64", "x-displayname": "CRL Server Port.", "x-ves-example": "80", "x-ves-validation-rules": { "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.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 } }, "timeout": { "type": "integer", "description": "CRL download wait time, in seconds.", "format": "int64", "x-displayname": "CRL download timeout.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "180" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "180" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 180, "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-minimum-configuration": { "description": "Minimum configuration for crlCreateSpecType", "required_fields": [ "refresh_interval", "server_address", "server_port", "timeout" ], "mutually_exclusive_groups": [], "example_json": "{\n \"refresh_interval\": 6,\n \"server_address\": \"example-crl.it.com\",\n \"server_port\": 1,\n \"timeout\": 1\n}", "example_yaml": "refresh_interval: 6\nserver_address: example-crl.it.com\nserver_port: 1\ntimeout: 1" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a crl", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.crl.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 crlDeleteRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read crl", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.crl.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/crlCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/crlReplaceRequest" } ], "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/crlGetSpecType" } ], "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/crlStatusObject" }, "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 crlGetResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlGetSpecType": { "type": "object", "description": "API to GET CRL.", "title": "Get CRL", "x-displayname": "GET CRL", "x-ves-oneof-field-access_info_choice": "[\"http_access\"]", "x-ves-proto-message": "ves.io.schema.crl.GetSpecType", "properties": { "http_access": { "allOf": [ { "$ref": "#/components/schemas/crlHTTPAccessInfo" } ], "x-f5xc-description-short": "Configuration parameter for http access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "refresh_interval": { "type": "integer", "description": "CRL refresh interval, in hours.", "format": "int64", "x-displayname": "CRL Refresh interval.", "x-ves-example": "24", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "6", "ves.io.schema.rules.uint32.lte": "168" }, "x-f5xc-example": "24", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "6", "ves.io.schema.rules.uint32.lte": "168" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 6, "maximum": 168, "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 } }, "server_address": { "type": "string", "description": "CRL server address or hostname.", "maxLength": 255, "x-displayname": "CRL Server address.", "x-ves-example": "example-crl.it.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname_or_ip": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-example": "example-crl.it.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname_or_ip": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "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 } }, "server_port": { "type": "integer", "description": "Set CRL Server port number.", "format": "int64", "x-displayname": "CRL Server Port.", "x-ves-example": "80", "x-ves-validation-rules": { "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.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 } }, "timeout": { "type": "integer", "description": "CRL download wait time, in seconds.", "format": "int64", "x-displayname": "CRL download timeout.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "180" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "180" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 180, "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-minimum-configuration": { "description": "Minimum configuration for crlGetSpecType", "required_fields": [ "refresh_interval", "server_address", "server_port", "timeout" ], "mutually_exclusive_groups": [], "example_json": "{\n \"refresh_interval\": 6,\n \"server_address\": \"example-crl.it.com\",\n \"server_port\": 1,\n \"timeout\": 1\n}", "example_yaml": "refresh_interval: 6\nserver_address: example-crl.it.com\nserver_port: 1\ntimeout: 1" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlHTTPAccessInfo": { "type": "object", "title": "HTTPAccessInfo", "x-displayname": "HTTPAccessInfo.", "x-ves-proto-message": "ves.io.schema.crl.HTTPAccessInfo", "properties": { "path": { "type": "string", "description": "CRL file location.", "title": "path", "maxLength": 256, "x-displayname": "CRL File path.", "x-ves-example": "/repo/latest.crl.", "x-ves-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-example": "/repo/latest.crl", "x-validation-rules": { "ves.io.schema.rules.string.http_path": "true", "ves.io.schema.rules.string.max_len": "256" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 256, "minLength": 1, "pattern": "^[/a-zA-Z0-9._-]+$", "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for crlHTTPAccessInfo", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of crl", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.crl.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/crlListResponseItem" }, "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 crlListResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlListResponseItem": { "type": "object", "description": "By default a summary of CRL 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 crl", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.crl.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this CRL.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this CRL.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this CRL.", "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 CRL is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates CRL is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/crlGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this CRL.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "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 CRL.", "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/crlStatusObject" }, "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 CRL.", "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 CRL 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 CRL 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 crlListResponseItem", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a crl", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.crl.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/crlReplaceSpecType" } ], "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 crlReplaceRequest", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.crl.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for crlReplaceResponse", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlReplaceSpecType": { "type": "object", "description": "API to replace CRL object.", "title": "Replace CRL", "x-displayname": "Replace CRL.", "x-ves-oneof-field-access_info_choice": "[\"http_access\"]", "x-ves-proto-message": "ves.io.schema.crl.ReplaceSpecType", "properties": { "http_access": { "allOf": [ { "$ref": "#/components/schemas/crlHTTPAccessInfo" } ], "x-f5xc-description-short": "Configuration parameter for http access.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "refresh_interval": { "type": "integer", "description": "CRL refresh interval, in hours.", "format": "int64", "x-displayname": "CRL Refresh interval.", "x-ves-example": "24", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "6", "ves.io.schema.rules.uint32.lte": "168" }, "x-f5xc-example": "24", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "6", "ves.io.schema.rules.uint32.lte": "168" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 6, "maximum": 168, "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 } }, "server_address": { "type": "string", "description": "CRL server address or hostname.", "maxLength": 255, "x-displayname": "CRL Server address.", "x-ves-example": "example-crl.it.com.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname_or_ip": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-example": "example-crl.it.com", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.hostname_or_ip": "true", "ves.io.schema.rules.string.max_len": "255" }, "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "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 } }, "server_port": { "type": "integer", "description": "Set CRL Server port number.", "format": "int64", "x-displayname": "CRL Server Port.", "x-ves-example": "80", "x-ves-validation-rules": { "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.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 } }, "timeout": { "type": "integer", "description": "CRL download wait time, in seconds.", "format": "int64", "x-displayname": "CRL download timeout.", "x-ves-example": "10", "x-ves-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "180" }, "x-f5xc-example": "10", "x-validation-rules": { "ves.io.schema.rules.uint32.gte": "1", "ves.io.schema.rules.uint32.lte": "180" }, "x-f5xc-constraints": { "constraintType": "number", "category": "discovery", "minimum": 1, "maximum": 180, "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-minimum-configuration": { "description": "Minimum configuration for crlReplaceSpecType", "required_fields": [ "refresh_interval", "server_address", "server_port", "timeout" ], "mutually_exclusive_groups": [], "example_json": "{\n \"refresh_interval\": 6,\n \"server_address\": \"example-crl.it.com\",\n \"server_port\": 1,\n \"timeout\": 1\n}", "example_yaml": "refresh_interval: 6\nserver_address: example-crl.it.com\nserver_port: 1\ntimeout: 1" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "crlStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "CRL Status Object", "x-displayname": "CRL Status.", "x-ves-proto-message": "ves.io.schema.crl.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Object reference.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for crlStatusObject", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "protobufAny": { "type": "object", "description": "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\nFoo foo = ...;\nAny any;\nany.packfrom(foo);\n...\nIf (any.unpackto(&foo)) {\n...\n}\n\nExample 2: Pack and unpack a message in Java.\n\nFoo foo = ...;\nAny any = any.pack(foo);\n...\nIf (any.is(foo.class)) {\nfoo = any.unpack(foo.class);\n}\n\nExample 3: Pack and unpack a message in Python.\n\nFoo = Foo(...)\nany = Any()\nany.pack(foo)\n...\nIf any.is(foo.descriptor):\nany.unpack(foo)\n...\n\nExample 4: Pack and unpack a message in Go\n\nfoo := &pb.foo{...}\nany, err := ptypes.marshalany(foo)\n...\nFoo := &pb.foo{}\nif err := ptypes.unmarshalany(any, foo); err != nil {\n...\n}\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.example.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\npackage google.profile;\nmessage Person {\nstring first_name = 1;\nstring last_name = 2;\n}\n\n{\n\"@type\": \"type.googleapis.com/google.profile.person\",\n\"firstName\": ,\n\"lastName\": \n}\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.duration][]):\n\n{\n\"@type\": \"type.googleapis.com/google.protobuf.duration\",\n\"value\": \"1.212s\"\n}", "properties": { "type_url": { "type": "string", "description": "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `HTTP`, `HTTPS`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `HTTPS` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.type][]\nvalue in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\nURL, or have them precompiled into a binary to avoid any\nlookup. Therefore, binary compatibility needs to be preserved\non changes to types. (Use versioned type names to manage\nbreaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `HTTP`, `HTTPS` (or the empty scheme) might be\nused with implementation specific semantics.", "x-f5xc-description-short": "URL identifying the protocol buffer message type.", "x-f5xc-description-medium": "URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in ).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "byte", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.", "x-f5xc-description-medium": "Contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for protobufAny", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaConditionType": { "type": "object", "description": "Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.", "title": "ConditionType", "x-displayname": "Status Condition.", "x-ves-proto-message": "ves.io.schema.ConditionType", "properties": { "hostname": { "type": "string", "description": "Hostname of the instance of the site that sent the status.", "title": "hostname", "x-displayname": "Hostname", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Hostname of the instance of the site that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "network", "maxLength": 1024, "minLength": 1, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "format": "fqdn", "validation": { "rfc": "RFC 1123" }, "metadata": { "source": "inferred", "confidence": 0.95, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "pattern": "^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$", "minLength": 1 }, "last_update_time": { "type": "string", "description": "Last time the condition was updated.", "title": "last_update_time", "format": "date-time", "x-displayname": "Last Updated.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human readable string explaining the reason for reaching this condition.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Insufficient memory in data plane.", "x-f5xc-example": "Insufficient memory in data plane", "x-f5xc-description-short": "Human readable string explaining the reason for reaching this condition.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "service_name": { "type": "string", "description": "Name of the service that sent the status.", "title": "service name", "x-displayname": "Service Name.", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that sent the status.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status": { "type": "string", "description": "Status of the condition\n\"Success\" Validation has succeeded. Requested operation was successful.\n\"Failed\" Validation has failed.\n\"Incomplete\" Validation of configuration has failed due to missing configuration.\n\"Installed\" Validation has passed and configuration has been installed in data path or K8s\n\"Down\" Configuration is operationally down. E.g. Down interface\n\"Disabled\" Configuration is administratively disabled i.e. objectmetatype.disable = true.\n\"NotApplicable\" Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.", "title": "status", "x-displayname": "Status", "x-ves-example": "Failed", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-example": "Failed", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]" }, "x-f5xc-description-short": "Status of the condition \"Success\" Validation has succeeded.", "x-f5xc-description-medium": "Status of the condition \"Success\" Validation has succeeded. Requested operation was successful. \"Failed\" Validation has failed. \"Incomplete\" Validation of configuration has failed due to missing configuration. \"Installed\" Validation has passed and configuration has been installed in data path or...", "maxLength": 1024, "enum": [ "Success", "Failed", "Incomplete", "Installed", "Down", "Disabled", "NotApplicable" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "type": { "type": "string", "description": "Type of the condition\n\"Validation\" represents validation user given configuration object\n\"Operational\" represents operational status of a given configuration object.", "title": "type", "x-displayname": "Type", "x-ves-example": "Operational.", "x-ves-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-example": "Operational", "x-validation-rules": { "ves.io.schema.rules.string.in": "[\\\"Validation\\\",\\\"Operational\\\"]" }, "x-f5xc-description-short": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given...", "x-f5xc-description-medium": "Type of the condition \"Validation\" represents validation user given configuration object \"Operational\" represents operational status of a given configuration object.", "maxLength": 1024, "enum": [ "Validation", "Operational" ], "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Conditions are used in the object status to describe the current state of the object, e.g.", "x-f5xc-description-medium": "Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaConditionType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaErrorCode": { "type": "string", "description": "Union of all possible error-codes from system\n\n- EOK: No error\n- EPERMS: Permissions error\n- EBADINPUT: Input is not correct\n- ENOTFOUND: Not found\n- EEXISTS: Already exists\n- EUNKNOWN: Unknown/catchall error\n- ESERIALIZE: Error in serializing/de-serializing\n- EINTERNAL: Server error\n- EPARTIAL: Partial error.", "title": "ErrorCode", "enum": [ "EOK", "EPERMS", "EBADINPUT", "ENOTFOUND", "EEXISTS", "EUNKNOWN", "ESERIALIZE", "EINTERNAL", "EPARTIAL" ], "default": "EOK", "x-displayname": "Error Code.", "x-ves-proto-enum": "ves.io.schema.ErrorCode", "x-f5xc-description-short": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found...", "x-f5xc-description-medium": "Union of all possible error-codes from system - EOK: No error - EPERMS: Permissions error - EBADINPUT: Input is not correct - ENOTFOUND: Not found - EEXISTS: Already exists - EUNKNOWN: Unknown/catchall error - ESERIALIZE: Error in serializing/de-serializing - EINTERNAL: Server error - EPARTIAL...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorCode", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"EOK\"", "example_yaml": "EOK\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaErrorType__ves_io_schema_ai_assistant": { "type": "object", "description": "Information about a error in API operation.", "title": "ErrorType", "x-displayname": "Error Type.", "x-ves-proto-message": "ves.io.schema.ErrorType", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/schemaErrorCode" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "error_obj": { "allOf": [ { "$ref": "#/components/schemas/protobufAny" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "message": { "type": "string", "description": "A human readable string of the error.", "title": "message", "x-displayname": "Message", "x-ves-example": "Value", "x-f5xc-example": "value", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Information about a error in API operation.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaErrorType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaInitializerType": { "type": "object", "description": "Initializer is information about an initializer that has not yet completed.", "title": "InitializerType", "x-displayname": "Initializer.", "x-ves-proto-message": "ves.io.schema.InitializerType", "properties": { "name": { "type": "string", "description": "Name of the service that is responsible for initializing this object.", "title": "name", "x-displayname": "Name", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Name of the service that is responsible for initializing this object.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "Initializer is information about an initializer that has not yet completed.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializerType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaInitializersType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "Initializers tracks the progress of initialization of a configuration object.", "title": "InitializersType", "x-displayname": "Initializers.", "x-ves-proto-message": "ves.io.schema.InitializersType", "properties": { "pending": { "type": "array", "description": "Pending is a list of initializers that must execute in order before this object is initialized.\nWhen the last pending initializer is removed, and no failing result is set, the initializers\nstruct will be set to nil and the object is considered as initialized and visible to all\nclients.", "title": "pending", "items": { "$ref": "#/components/schemas/schemaInitializerType" }, "x-displayname": "Pending", "x-f5xc-description-short": "Pending is a list of initializers that must execute in order before this object is initialized.", "x-f5xc-description-medium": "Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "result": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Initializers tracks the progress of initialization of a configuration object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaInitializersType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaObjectCreateMetaType": { "type": "object", "description": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "title": "ObjectCreateMetaType", "x-displayname": "Create Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectCreateMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectCreateMetaType is metadata that can be specified in Create request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectCreateMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaObjectGetMetaType": { "type": "object", "description": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "title": "ObjectGetMetaType", "x-displayname": "GET Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectGetMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotation.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-ves-example": "True", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectGetMetaType is metadata that can be specified in GET/Create response of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectGetMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaObjectReplaceMetaType": { "type": "object", "description": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "title": "ObjectReplaceMetaType", "x-displayname": "Replace Metadata.", "x-ves-proto-message": "ves.io.schema.ObjectReplaceMetaType", "properties": { "annotations": { "type": "object", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.", "title": "annotations", "x-displayname": "Annotations.", "x-ves-example": "Value", "x-ves-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.map.keys.string.max_len": "64", "ves.io.schema.rules.map.keys.string.min_len": "1", "ves.io.schema.rules.map.values.string.max_len": "1024", "ves.io.schema.rules.map.values.string.min_len": "1" }, "x-f5xc-description-short": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata.", "x-f5xc-description-medium": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "Human readable description for the object.", "title": "description", "maxLength": 1200, "x-displayname": "Description.", "x-ves-example": "Virtual Host for Example Corp website.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-example": "Virtual Host for Example Corp website", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "1200" }, "x-f5xc-description-short": "Human readable description for the object.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 1200, "minLength": 0, "characterSet": { "description": "Free text with UTF-8 support" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "byteLength": { "max": 1200 }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 21, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "disable": { "type": "boolean", "description": "A value of true will administratively disable the object.", "title": "disable", "format": "boolean", "x-displayname": "Disable", "x-f5xc-example": "true", "x-f5xc-description-short": "Value of true will administratively disable the object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the user. Values specified here will be used\nby selector expression.", "title": "labels", "x-displayname": "Labels", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "name": { "type": "string", "description": "This is the name of configuration object. It has to be unique within the namespace.\nIt can only be specified during create API and cannot be changed during replace API.\nThe value of name has to follow DNS-1035 format.", "title": "name", "x-displayname": "Name", "x-ves-example": "Example-corp-web.", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-example": "example-corp-web", "x-validation-rules": { "ves.io.schema.rules.message.required": "true" }, "x-f5xc-description-short": "Name of configuration object. It has to be unique within the namespace.", "x-f5xc-description-medium": "Name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "This defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Staging", "x-f5xc-example": "staging", "x-f5xc-description-short": "Defines the workspace within which each the configuration object is to be created.", "x-f5xc-description-medium": "Defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\".", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" } }, "x-f5xc-description-short": "ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaObjectReplaceMetaType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"example-corp-web\"\n}", "example_yaml": "name: example-corp-web" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaStatusMetaType": { "type": "object", "description": "StatusMetaType is metadata that all status must have.", "title": "StatusMetaType", "x-displayname": "Metadata", "x-ves-proto-message": "ves.io.schema.StatusMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "Creation_timestamp is when the status object was created. It is used to find/tie-break\nfor latest status object from same origin.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "x-f5xc-description-medium": "Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "Class of creator which created this StatusObject. This will be service's DNS FQDN.\nThis will be set by the system based on client certificate information.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "ver.re1.int.ves.I/O.", "x-f5xc-example": "ver.re1.int.F5 XC", "x-f5xc-description-short": "Class of creator which created this StatusObject. This will be service's DNS FQDN.", "x-f5xc-description-medium": "Class of creator which created this StatusObject. This will be service's DNS FQDN. This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\nIdentifying the environment also). This will be set by the system based on client certificate\ninformation.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Ver-instance-1.", "x-f5xc-example": "ver-instance-1", "x-f5xc-description-short": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.", "x-f5xc-description-medium": "ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "publish": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusPublishType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "status_id": { "type": "string", "description": "Status_id is a field used by the generator to distinguish (if necessary) between two status\nobjects for the same config object from the same site and same service and potentially same\ndaemon(creator-ID)", "title": "status_id", "x-displayname": "Status ID", "x-f5xc-description-short": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site...", "x-f5xc-description-medium": "Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID).", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for a StatusObject.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for a StatusObject.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "vtrp_id": { "type": "string", "description": "Origin of this status exchanged by VTRP.", "title": "vtrp_id", "x-displayname": "VTRP ID", "x-f5xc-description-short": "Origin of this status exchanged by VTRP.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "vtrp_stale": { "type": "boolean", "description": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "title": "vtrp_stale", "format": "boolean", "x-displayname": "VTRP Stale.", "x-f5xc-description-short": "Indicate whether mars deems this object to be stale via graceful restart timer information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "StatusMetaType is metadata that all status must have.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaStatusPublishType": { "type": "string", "description": "StatusPublishType is all possible publish operations on a StatusObject\n\n- STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n- STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable.", "title": "StatusPublishType", "enum": [ "STATUS_DO_NOT_PUBLISH", "STATUS_PUBLISH" ], "default": "STATUS_DO_NOT_PUBLISH", "x-displayname": "Status Publish Type.", "x-ves-proto-enum": "ves.io.schema.StatusPublishType", "x-f5xc-description-short": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user.", "x-f5xc-description-medium": "StatusPublishType is all possible publish operations on a StatusObject - STATUS_DO_NOT_PUBLISH: Do Not Publish Do not propagate this status to user. This could be because status is only informational - STATUS_PUBLISH: Publish Propagate this status up to user as it might be actionable.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusPublishType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"STATUS_DO_NOT_PUBLISH\"", "example_yaml": "STATUS_DO_NOT_PUBLISH\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaStatusType": { "type": "object", "description": "Status is a return value for calls that don't return other objects.", "title": "StatusType", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.StatusType", "properties": { "code": { "type": "integer", "description": "Suggested HTTP return code for this status, 0 if not set.", "title": "code", "format": "int32", "x-displayname": "Code", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Suggested HTTP return code for this status, 0 if not set.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "reason": { "type": "string", "description": "A human-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available.", "title": "reason", "x-displayname": "Reason", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "x-f5xc-description-medium": "Human-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 27, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "status": { "type": "string", "description": "Status of the operation.\nOne of: \"Success\" or \"Failure\".", "title": "status", "x-displayname": "Status", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Status of the operation. One of: \"Success\" or \"Failure\".", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 17, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Status is a return value for calls that don't return other objects.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaStatusType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaSystemObjectGetMetaType__ves_io_schema_api_sec_api_crawler": { "type": "object", "description": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.", "title": "SystemObjectGetMetaType", "x-displayname": "System Metadata.", "x-ves-proto-message": "ves.io.schema.SystemObjectGetMetaType", "properties": { "creation_timestamp": { "type": "string", "description": "CreationTimestamp is a timestamp representing the server time when this object was\ncreated. It is not guaranteed to be set in happens-before order across separate operations.\nClients may not set this value. It is represented in RFC3339 form and is in UTC.", "title": "creation_timestamp", "format": "date-time", "x-displayname": "Creation Timestamp.", "x-f5xc-description-short": "CreationTimestamp is a timestamp representing the server time when this object was created.", "x-f5xc-description-medium": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_class": { "type": "string", "description": "A value identifying the class of the user or service which created this configuration object.", "title": "creator_class", "x-displayname": "Creator Class.", "x-ves-example": "Prism", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the class of the user or service which created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "creator_id": { "type": "string", "description": "A value identifying the exact user or service that created this configuration object.", "title": "creator_id", "x-displayname": "Creator ID.", "x-ves-example": "Admin@example.com.", "x-f5xc-example": "value", "x-f5xc-description-short": "Value identifying the exact user or service that created this configuration object.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "deletion_timestamp": { "type": "string", "description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\nfield is set by the server when a graceful deletion is requested by the user, and is not\ndirectly settable by a client. The resource is expected to be deleted (no longer visible\nfrom resource lists, and not reachable by name) after the time in this field, once the\nfinalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\nOnce the deletionTimestamp is set, this value may not be unset or be set further into the\nfuture, although it may be shortened or the resource may be deleted prior to this time.\nFor example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\nby sending a graceful termination signal to the containers in the pod. After that 30 seconds,\nthe Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\nremove the pod from the API. In the presence of network partitions, this object may still\nexist after this timestamp, until an administrator or automated process can determine the\nresource is fully terminated.\nIf not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested.\nRead-only.", "title": "deletion_timestamp", "format": "date-time", "x-displayname": "Deletion Timestamp.", "x-f5xc-description-short": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted.", "x-f5xc-description-medium": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not...", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "finalizers": { "type": "array", "description": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.", "title": "finalizers", "items": { "type": "string" }, "x-displayname": "Finalizers.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Must be empty before the object is deleted from the registry.", "x-f5xc-description-medium": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "initializers": { "allOf": [ { "$ref": "#/components/schemas/schemaInitializersType__ves_io_schema_api_sec_api_crawler" } ], "x-f5xc-description-short": "Configuration parameter for initializers.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects as chosen by the operator or software. Values here can be interpreted\nby software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "title": "labels", "x-displayname": "Labels", "x-ves-example": "'VES.I/O/soft-deleted': 'true'", "x-f5xc-example": "'F5 XC/soft-deleted''true'", "x-f5xc-description-short": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software.", "x-f5xc-description-medium": "Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "modification_timestamp": { "type": "string", "description": "ModificationTimestamp is a timestamp representing the server time when this object was\nlast modified.", "title": "modification_timestamp", "format": "date-time", "x-displayname": "Modification Timestamp.", "x-f5xc-description-short": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "x-f5xc-description-medium": "ModificationTimestamp is a timestamp representing the server time when this object was last modified.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "format": "date-time", "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "object_index": { "type": "integer", "description": "Unique index for the object. Some objects need a unique integer index to be allocated\nfor each object type. This field will be populated for all objects that need it and will\nbe zero otherwise.", "title": "object_index", "format": "int64", "x-displayname": "Object Index.", "x-ves-example": "0", "x-f5xc-example": "0", "x-f5xc-description-short": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type.", "x-f5xc-description-medium": "Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only" }, "owner_view": { "allOf": [ { "$ref": "#/components/schemas/schemaViewRefType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": null, "field_path": "owner_view", "gated_by": null, "required": false, "cardinality": "single" } ] }, "tenant": { "type": "string", "description": "Tenant to which this configuration object belongs to. The value for this is found from\npresented credentials.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "x-f5xc-description-medium": "Tenant to which this configuration object belongs to. The value for this is found from presented credentials.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "Uid is the unique in time and space value for this object. It is generated by\nthe server on successful creation of an object and is not allowed to change on Replace\nAPI. The value of is taken from uid field of ObjectMetaType, if provided.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "Uid is the unique in time and space value for this object.", "x-f5xc-description-medium": "Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-description-medium": "SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and cannot be updated directly by users.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSystemObjectGetMetaType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaViewRefType": { "type": "object", "description": "ViewRefType represents a reference to a view.", "title": "ViewRefType", "x-displayname": "View Reference.", "x-ves-proto-message": "ves.io.schema.ViewRefType", "properties": { "kind": { "type": "string", "description": "Kind of the view object.", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Http_proxy.", "x-f5xc-example": "http_proxy", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter, may contain lowercase alphanumeric and hyphens, must end with alphanumeric", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "uid": { "type": "string", "description": "UID of the view object.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-d543fad8e1f8.", "x-f5xc-example": "00000000-0000-4000-8000-d543fad8e1f8", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "ViewRefType represents a reference to a view.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaViewRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "certificateCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of certificate", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.certificate.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/certificateCreateSpecType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "TLS certificate for securing HTTPS endpoints and connections", "required_fields": [ "metadata.name", "metadata.namespace", "spec.certificate_url", "spec.private_key" ], "mutually_exclusive_groups": [ { "name": "private_key_type", "fields": [ "spec.private_key.clear_secret_info", "spec.private_key.blindfold_secret_info" ], "reason": "Clear text (automation) vs blindfold-encrypted (production)" } ], "example_yaml": "apiVersion: v1\nkind: certificate\nmetadata:\n name: example-cert\n namespace: default\nspec:\n certificate_url: \"string:///BASE64_ENCODED_CERTIFICATE\"\n private_key:\n clear_secret_info:\n url: \"string:///BASE64_ENCODED_PRIVATE_KEY\"\n provider: \"\"\n", "example_json": "{\n \"metadata\": {\n \"name\": \"example-cert\",\n \"namespace\": \"default\"\n },\n \"spec\": {\n \"certificate_url\": \"string:///{{CERT_B64}}\",\n \"private_key\": {\n \"clear_secret_info\": {\n \"url\": \"string:///{{KEY_B64}}\",\n \"provider\": \"\"\n }\n }\n }\n}\n" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.certificate.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/certificateGetSpecType" } ], "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 certificateCreateResponse", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateCreateSpecType": { "type": "object", "description": "Shape of the Certificate specification.", "title": "Create Certificate", "x-displayname": "Create Certificate.", "x-ves-oneof-field-ocsp_stapling_choice": "[\"custom_hash_algorithms\",\"disable_ocsp_stapling\",\"use_system_defaults\"]", "x-ves-proto-message": "ves.io.schema.certificate.CreateSpecType", "properties": { "certificate_chain": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for certificate chain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "certificate_chain", "field_path": "certificate_chain", "gated_by": null, "required": false, "cardinality": "single" } ] }, "certificate_url": { "type": "string", "description": "Certificate.\nCertificate or certificate chain in PEM format including the PEM headers.", "minLength": 1, "maxLength": 131072, "x-displayname": "Certificate.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.certificate_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.certificate_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 131072, "byteLength": { "max": 131072, "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 } }, "custom_hash_algorithms": { "allOf": [ { "$ref": "#/components/schemas/schemaHashAlgorithms" } ], "x-f5xc-description-short": "Configuration parameter for custom hash algorithms.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_ocsp_stapling", "use_system_defaults" ] }, "disable_ocsp_stapling": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable ocsp stapling.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_hash_algorithms", "use_system_defaults" ] }, "private_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-description-short": "Private key for asymmetric cryptography.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_system_defaults": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use system defaults.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_hash_algorithms", "disable_ocsp_stapling" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificateCreateSpecType", "required_fields": [ "certificate_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"certificate_url\": \"value\"\n}", "example_yaml": "certificate_url: value" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-recommended-oneof-variant": { "ocsp_stapling_choice": "use_system_defaults" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a certificate", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.certificate.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 certificateDeleteRequest", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read certificate", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.certificate.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/certificateCreateRequest" } ], "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/certificateReplaceRequest" } ], "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/certificateGetSpecType" } ], "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/certificateStatusObject" }, "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 certificateGetResponse", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateGetSpecType": { "type": "object", "description": "Shape of the Certificate specification.", "title": "Get Certificate", "x-displayname": "GET Certificate.", "x-ves-oneof-field-ocsp_stapling_choice": "[\"custom_hash_algorithms\",\"disable_ocsp_stapling\",\"use_system_defaults\"]", "x-ves-oneof-field-provider": "[\"manual\",\"virtual_host_auto_cert\"]", "x-ves-proto-message": "ves.io.schema.certificate.GetSpecType", "properties": { "certificate_chain": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for certificate chain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "certificate", "field_path": "certificate_chain", "gated_by": null, "required": false, "cardinality": "single" } ] }, "certificate_url": { "type": "string", "description": "Certificate.\nCertificate or certificate chain in PEM format including the PEM headers.", "minLength": 1, "maxLength": 131072, "x-displayname": "Certificate.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.certificate_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.certificate_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 131072, "byteLength": { "max": 131072, "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 } }, "custom_hash_algorithms": { "allOf": [ { "$ref": "#/components/schemas/schemaHashAlgorithms" } ], "x-f5xc-description-short": "Configuration parameter for custom hash algorithms.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_ocsp_stapling", "use_system_defaults" ] }, "disable_ocsp_stapling": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable ocsp stapling.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_hash_algorithms", "use_system_defaults" ] }, "http_loadbalancers": { "type": "array", "description": "HTTP Loadbalancers using this certificate.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "HTTP Loadbalancers.", "x-f5xc-description-short": "HTTP Loadbalancers using this certificate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "infos": { "type": "array", "description": "Information about this certificate.", "items": { "$ref": "#/components/schemas/schemaCertInfoType" }, "x-displayname": "Certificate Information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "manual": { "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": [ "virtual_host_auto_cert" ] }, "private_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-description-short": "Private key for asymmetric cryptography.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "tcp_loadbalancers": { "type": "array", "description": "TCP Loadbalancers using this certificate.", "items": { "$ref": "#/components/schemas/schemaviewsObjectRefType" }, "x-displayname": "TCP Loadbalancers.", "x-f5xc-description-short": "TCP Loadbalancers using this certificate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_system_defaults": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use system defaults.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_hash_algorithms", "disable_ocsp_stapling" ] }, "virtual_host_auto_cert": { "allOf": [ { "$ref": "#/components/schemas/certificateVirtualHostAutoCert" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "manual" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificateGetSpecType", "required_fields": [ "certificate_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"certificate_url\": \"value\"\n}", "example_yaml": "certificate_url: value" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-recommended-oneof-variant": { "ocsp_stapling_choice": "use_system_defaults" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of certificate", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.certificate.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/certificateListResponseItem" }, "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 certificateListResponse", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateListResponseItem": { "type": "object", "description": "By default a summary of certificate 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 certificate", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.certificate.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this certificate.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this certificate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this certificate.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this certificate.", "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 certificate is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates certificate is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/certificateGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this certificate.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this certificate.", "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 certificate.", "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/certificateStatusObject" }, "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 certificate.", "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 certificate 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 certificate 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 certificateListResponseItem", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a certificate", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.certificate.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/certificateReplaceSpecType" } ], "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": "TLS certificate for securing HTTPS endpoints and connections", "required_fields": [], "mutually_exclusive_groups": [ { "name": "private_key_type", "fields": [ "spec.private_key.clear_secret_info", "spec.private_key.blindfold_secret_info" ], "reason": "Clear text (automation) vs blindfold-encrypted (production)" } ], "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.certificate.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificateReplaceResponse", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateReplaceSpecType": { "type": "object", "description": "Shape of the Certificate specification.", "title": "Replace Certificate", "x-displayname": "Replace Certificate.", "x-ves-oneof-field-ocsp_stapling_choice": "[\"custom_hash_algorithms\",\"disable_ocsp_stapling\",\"use_system_defaults\"]", "x-ves-proto-message": "ves.io.schema.certificate.ReplaceSpecType", "properties": { "certificate_chain": { "allOf": [ { "$ref": "#/components/schemas/schemaviewsObjectRefType" } ], "x-f5xc-description-short": "Configuration parameter for certificate chain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-references": [ { "resource_kind": "certificate", "field_path": "certificate_chain", "gated_by": null, "required": false, "cardinality": "single" } ] }, "certificate_url": { "type": "string", "description": "Certificate.\nCertificate or certificate chain in PEM format including the PEM headers.", "minLength": 1, "maxLength": 131072, "x-displayname": "Certificate.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.certificate_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.certificate_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Certificate. Certificate or certificate chain in PEM format including the PEM headers.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 131072, "byteLength": { "max": 131072, "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 } }, "custom_hash_algorithms": { "allOf": [ { "$ref": "#/components/schemas/schemaHashAlgorithms" } ], "x-f5xc-description-short": "Configuration parameter for custom hash algorithms.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "disable_ocsp_stapling", "use_system_defaults" ] }, "disable_ocsp_stapling": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for disable ocsp stapling.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_hash_algorithms", "use_system_defaults" ] }, "private_key": { "allOf": [ { "$ref": "#/components/schemas/schemaSecretType" } ], "x-f5xc-example": "example", "x-f5xc-description-short": "Private key for asymmetric cryptography.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "use_system_defaults": { "allOf": [ { "$ref": "#/components/schemas/ioschemaEmpty" } ], "x-f5xc-description-short": "Configuration parameter for use system defaults.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "custom_hash_algorithms", "disable_ocsp_stapling" ] } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificateReplaceSpecType", "required_fields": [ "certificate_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"certificate_url\": \"value\"\n}", "example_yaml": "certificate_url: value" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-recommended-oneof-variant": { "ocsp_stapling_choice": "use_system_defaults" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for Certificate", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.certificate.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various component of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various component of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Reference to object for current status.", "title": "object_refs", "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificateStatusObject", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificateVirtualHostAutoCert": { "type": "object", "description": "AutoCert provider information.", "title": "Virtual Host Auto Cert", "x-displayname": "Virtual Host Auto Cert.", "x-ves-proto-message": "ves.io.schema.certificate.VirtualHostAutoCert", "properties": { "owner_virtual_host": { "type": "array", "description": "The virtual_host object that owns this certificate.", "title": "Owner Virtual Host", "maxItems": 1, "items": { "$ref": "#/components/schemas/ioschemaObjectRefType" }, "x-displayname": "Owner Virtual Host.", "x-ves-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-validation-rules": { "ves.io.schema.rules.repeated.max_items": "1" }, "x-f5xc-description-short": "The virtual_host object that owns this certificate.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "maxItems": 1, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificateVirtualHostAutoCert", "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": "Certificates can be managed in any namespace" }, "classification": { "category": "certificate", "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": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "ioschemaObjectRefType": { "type": "object", "description": "This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.ObjectRefType", "properties": { "kind": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen kind will hold the referred object's kind (e.g. \"route\")", "title": "kind", "x-displayname": "Kind", "x-ves-example": "Virtual_site.", "x-f5xc-example": "virtual_site", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\")", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object's kind (e.g. \"route\").", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "x-displayname": "Name", "x-ves-example": "Contactus-route.", "x-f5xc-example": "contactus-route", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 6, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-f5xc-example": "ns1", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "maxLength": 63, "x-f5xc-constraints": { "constraintType": "string", "category": "naming", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "inferred", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-f5xc-example": "example-corp", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "uid": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen uid will hold the referred object's(e.g. Route's) uid.", "title": "uid", "x-displayname": "UID", "x-ves-example": "00000000-0000-4000-8000-0df41b679859.", "x-f5xc-example": "00000000-0000-4000-8000-0df41b679859", "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object's(e.g. Route's) uid.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 36, "format": "uuid", "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a 'direct reference' from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector...", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for ioschemaObjectRefType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaBlindfoldSecretInfoType": { "type": "object", "description": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "title": "BlindfoldSecretInfoType", "x-displayname": "Blindfold Secret.", "x-ves-displayorder": "3,1,2", "x-ves-proto-message": "ves.io.schema.BlindfoldSecretInfoType", "properties": { "decryption_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "title": "Decryption Provider", "x-displayname": "Decryption Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the backend Secret Management service.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "location": { "type": "string", "description": "Location is the uri_ref. It could be in URL format for string:///\nOr it could be a path if the store provider is an HTTP/HTTPS location.", "title": "Location", "x-displayname": "Location", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "x-f5xc-description-medium": "Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "content", "minLength": 4, "maxLength": 131072, "format": "uri", "deterministic": true, "metadata": { "source": "manual-override", "confidence": 1.0, "category": "content", "note": "Blindfold envelope encryption (AES-256-GCM + RSA-OAEP) of an RSA-2048 TLS private key produces ~3700 char string:/// URL. 128KB max secret size = ~175KB base64. Discovery reported 1024 which is incorrect.", "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false }, "minLength": 4, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "store_provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Store Provider", "x-displayname": "Store Provider.", "x-ves-example": "Value", "x-f5xc-example": "value", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaBlindfoldSecretInfoType", "required_fields": [ "location" ], "mutually_exclusive_groups": [], "example_json": "{\n \"location\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "location: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Standard tenant resource" }, "classification": { "category": "security", "multi_tenant_pattern": "per-tenant" } } }, "schemaCertInfoType": { "type": "object", "description": "Information about a certificate.", "title": "Certificate Information", "x-displayname": "Certificate Information.", "x-ves-proto-message": "ves.io.schema.CertInfoType", "properties": { "common_name": { "type": "string", "description": "Common Name (CN) of this certificate.", "title": "Common Name", "x-displayname": "Common Name.", "x-f5xc-example": "example-resource", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "expiry": { "type": "string", "description": "Expiry timestamp of this certificate.", "title": "Expiry Timestamp", "format": "date-time", "x-displayname": "Expiry Timestamp.", "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 } }, "issuer": { "type": "string", "description": "Issuer of this certificate.", "title": "Issuer", "x-displayname": "Issuer", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "organization": { "type": "string", "description": "Organization of this certificate.", "title": "Organization", "x-displayname": "Organization.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "public_key_algorithm": { "type": "string", "description": "Public Key Algorithm of this certificate.", "title": "Public Key Algorithm", "x-displayname": "Public Key Algorithm.", "x-f5xc-description-short": "Public Key Algorithm of this certificate.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "subject_alternative_names": { "type": "array", "description": "Subject Alternative Names of this certificate.", "title": "Subject Alternative Names", "items": { "type": "string" }, "x-displayname": "SANs", "x-f5xc-example": "example-resource", "x-f5xc-description-short": "Subject Alternative Names of this certificate.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaCertInfoType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaClearSecretInfoType": { "type": "object", "description": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "title": "ClearSecretInfoType", "x-displayname": "In-Clear Secret.", "x-ves-displayorder": "2,1", "x-ves-proto-message": "ves.io.schema.ClearSecretInfoType", "properties": { "provider": { "type": "string", "description": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes\nThis field needs to be provided only if the URL scheme is not string:///.", "title": "Provider", "x-displayname": "Provider", "x-ves-example": "Box-provider.", "x-f5xc-example": "box-provider", "x-f5xc-description-short": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only...", "x-f5xc-description-medium": "Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 0.85, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 3, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" }, "url": { "type": "string", "description": "URL of the secret. Currently supported URL schemes is string:///.\nFor string:/// scheme, Secret needs to be encoded Base64 format.\nWhen asked for this secret, caller will GET Secret bytes after Base64 decoding.", "title": "URL", "maxLength": 131072, "x-displayname": "URL", "x-ves-example": "String:///U2VjcmV0SW5mb3JtYXRpb24=.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-sensitive": true, "x-f5xc-example": "string:///U2VjcmV0SW5mb3JtYXRpb24=", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.uri_ref": "true" }, "x-f5xc-description-short": "URL of the secret. Currently supported URL schemes is string:///.", "x-f5xc-description-medium": "URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding.", "format": "uri", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 131072, "format": "uri", "minLength": 1, "pattern": "^(https?|ftp)://[^\\s/$.?#].[^\\s]*$", "formatDescription": "RFC 3986 URI with scheme (http, https, ftp)", "validation": { "rfc": "RFC 3986" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 131072 } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "ClearSecretInfoType specifies information about the Secret that is not encrypted.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaClearSecretInfoType", "required_fields": [ "url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"url\": \"string:///U2VjcmV0SW5mb3JtYXRpb24=\"\n}", "example_yaml": "url: string:///U2VjcmV0SW5mb3JtYXRpb24=" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaHashAlgorithm": { "type": "string", "description": "Specifies the Hash Algorithm to be used\n\nInvalid hash algorithm\nsha256 hash algorithm\nsha1 hash algorithm.", "title": "HashAlgoritm", "enum": [ "INVALID_HASH_ALGORITHM", "SHA256", "SHA1" ], "default": "INVALID_HASH_ALGORITHM", "x-displayname": "Hash Algorithm.", "x-ves-proto-enum": "ves.io.schema.HashAlgorithm", "x-f5xc-description-short": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.", "x-f5xc-description-medium": "Specifies the Hash Algorithm to be used Invalid hash algorithm sha256 hash algorithm sha1 hash algorithm.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaHashAlgorithm", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "\"INVALID_HASH_ALGORITHM\"", "example_yaml": "INVALID_HASH_ALGORITHM\n..." }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaHashAlgorithms": { "type": "object", "description": "Specifies the hash algorithms to be used.", "title": "HashAlgorithms", "x-displayname": "Hash Algorithms.", "x-ves-proto-message": "ves.io.schema.HashAlgorithms", "properties": { "hash_algorithms": { "type": "array", "description": "Ordered list of hash algorithms to be used.", "title": "Hash Algorithms", "minItems": 1, "maxItems": 4, "items": { "$ref": "#/components/schemas/schemaHashAlgorithm" }, "x-displayname": "Hash Algorithms.", "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": "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": "4", "ves.io.schema.rules.repeated.min_items": "1", "ves.io.schema.rules.repeated.unique": "true" }, "x-f5xc-description-short": "Ordered list of hash algorithms to be used.", "x-f5xc-constraints": { "constraintType": "array", "category": "discovery", "minItems": 1, "maxItems": 4, "uniqueItems": true, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } } }, "x-f5xc-description-short": "Specifies the hash algorithms to be used.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaHashAlgorithms", "required_fields": [ "hash_algorithms" ], "mutually_exclusive_groups": [], "example_json": "{\n \"hash_algorithms\": [\n \"INVALID_HASH_ALGORITHM\"\n ]\n}", "example_yaml": "hash_algorithms:\n- INVALID_HASH_ALGORITHM" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "schemaSecretType": { "type": "object", "description": "SecretType is used in an object to indicate a sensitive/confidential field.", "title": "SecretType", "x-displayname": "Secret", "x-ves-oneof-field-secret_info_oneof": "[\"blindfold_secret_info\",\"clear_secret_info\"]", "x-ves-proto-message": "ves.io.schema.SecretType", "properties": { "blindfold_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaBlindfoldSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "clear_secret_info" ] }, "clear_secret_info": { "allOf": [ { "$ref": "#/components/schemas/schemaClearSecretInfoType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "x-f5xc-conflicts-with": [ "blindfold_secret_info" ] } }, "x-f5xc-description-short": "SecretType is used in an object to indicate a sensitive/confidential field.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaSecretType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "system" ], "enforced": false }, "recommendation": { "primary": "system", "alternatives": [], "rationale": "Secret management is platform-level" }, "classification": { "category": "identity", "multi_tenant_pattern": "none" } } }, "schemaviewsObjectRefType": { "type": "object", "description": "This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name.", "title": "ObjectRefType", "x-displayname": "Object reference.", "x-ves-proto-message": "ves.io.schema.views.ObjectRefType", "properties": { "name": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen name will hold the referred object's(e.g. Route's) name.", "title": "name", "minLength": 1, "maxLength": 128, "x-displayname": "Name", "x-ves-example": "Contacts-route.", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "contacts-route", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.max_bytes": "128", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object's(e.g. Route's) name.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 128, "byteLength": { "max": 128, "min": 1 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": true, "create": true, "update": false, "read": false } }, "namespace": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen namespace will hold the referred object's(e.g. Route's) namespace.", "title": "namespace", "maxLength": 63, "x-displayname": "Namespace", "x-ves-example": "Ns1", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "ns1", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object's(e.g. Route's) namespace.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 63, "minLength": 1, "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$", "characterSet": { "allowed": "[a-z0-9-]", "restricted": "[^a-z0-9-]", "required": "[a-z0-9]", "description": "Lowercase letter start, alphanumeric with hyphens, alphanumeric end" }, "format": "dns-label", "formatDescription": "DNS-1035 label: must start with a lowercase letter", "validation": { "rfc": "RFC 1035", "standard": "DNS-1035 label (alpha-first)" }, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" }, "deterministic": true, "byteLength": { "max": 64 } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "minLength": 1, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00", "pattern": "^[a-z]([-a-z0-9]*[a-z0-9])?$" }, "tenant": { "type": "string", "description": "When a configuration object(e.g. Virtual_host) refers to another(e.g route)\nthen tenant will hold the referred object's(e.g. Route's) tenant.", "title": "tenant", "maxLength": 64, "x-displayname": "Tenant", "x-ves-example": "Example-corp.", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-example": "example-corp", "x-validation-rules": { "ves.io.schema.rules.string.max_bytes": "64" }, "x-f5xc-description-short": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g.", "x-f5xc-description-medium": "When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object's(e.g. Route's) tenant.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 64, "byteLength": { "max": 64 }, "deterministic": true, "metadata": { "source": "discovery", "confidence": 0.99, "validatedAt": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false }, "readOnly": true, "x-field-mutability": "read-only", "minLength": 12, "x-reconciled-from-discovery": true, "x-reconciled-at": "2026-09-24T11:00:01+00:00" } }, "x-f5xc-description-short": "Type establishes a direct reference from one object(the referrer) to another(the referred).", "x-f5xc-description-medium": "Type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for schemaviewsObjectRefType", "required_fields": [ "name" ], "mutually_exclusive_groups": [], "example_json": "{\n \"name\": \"contacts-route\"\n}", "example_yaml": "name: contacts-route" }, "x-f5xc-cli-domain": "other", "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": false }, "recommendation": { "primary": "shared", "alternatives": [], "rationale": "Certificate revocation lists should be centralized" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "certificate_chainCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of certificate_chain", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.certificate_chain.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/certificate_chainCreateSpecType" } ], "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 certificate_chainCreateRequest", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.certificate_chain.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/certificate_chainGetSpecType" } ], "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 certificate_chainCreateResponse", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainCreateSpecType": { "type": "object", "description": "Shape of the Certificate Chain specification.", "title": "Create Certificate Chain", "x-displayname": "Create Certificate Chain.", "x-ves-proto-message": "ves.io.schema.certificate_chain.CreateSpecType", "properties": { "certificate_url": { "type": "string", "description": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.", "minLength": 1, "maxLength": 131072, "x-displayname": "Certificates.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.intermediate_certificate_chain_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.intermediate_certificate_chain_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 131072, "byteLength": { "max": 131072, "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 } } }, "x-f5xc-description-short": "Shape of the Certificate Chain specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificate_chainCreateSpecType", "required_fields": [ "certificate_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"certificate_url\": \"value\"\n}", "example_yaml": "certificate_url: value" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-recommended-oneof-variant": { "ocsp_stapling_choice": "use_system_defaults" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a certificate_chain", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.certificate_chain.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 certificate_chainDeleteRequest", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read certificate_chain", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.certificate_chain.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/certificate_chainCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/certificate_chainReplaceRequest" } ], "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/certificate_chainGetSpecType" } ], "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/certificate_chainStatusObject" }, "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 certificate_chainGetResponse", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainGetSpecType": { "type": "object", "description": "Shape of the Certificate Chain specification.", "title": "Get Certificate Chain", "x-displayname": "GET Certificate Chain.", "x-ves-proto-message": "ves.io.schema.certificate_chain.GetSpecType", "properties": { "certificate_url": { "type": "string", "description": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.", "minLength": 1, "maxLength": 131072, "x-displayname": "Certificates.", "x-ves-example": "Value", "x-ves-required": "true", "x-ves-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.intermediate_certificate_chain_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-example": "value", "x-validation-rules": { "ves.io.schema.rules.message.required": "true", "ves.io.schema.rules.string.intermediate_certificate_chain_url": "true", "ves.io.schema.rules.string.max_bytes": "131072", "ves.io.schema.rules.string.min_bytes": "1" }, "x-f5xc-description-short": "Certificate chain is the list of intermediate certificates in PEM format including the PEM headers.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "minLength": 1, "maxLength": 131072, "byteLength": { "max": 131072, "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 } }, "infos": { "type": "array", "description": "Information about certificate chain.", "items": { "$ref": "#/components/schemas/schemaCertInfoType" }, "x-displayname": "Certificate Chain Information.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Shape of the Certificate Chain specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificate_chainGetSpecType", "required_fields": [ "certificate_url" ], "mutually_exclusive_groups": [], "example_json": "{\n \"certificate_url\": \"value\"\n}", "example_yaml": "certificate_url: value" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-recommended-oneof-variant": { "ocsp_stapling_choice": "use_system_defaults" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of certificate_chain", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.certificate_chain.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/certificate_chainListResponseItem" }, "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 certificate_chainListResponse", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainListResponseItem": { "type": "object", "description": "By default a summary of certificate_chain 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 certificate_chain", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.certificate_chain.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this certificate_chain.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this certificate_chain.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this certificate_chain.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this certificate_chain.", "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 certificate_chain is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates certificate_chain is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/certificate_chainGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this certificate_chain.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this certificate_chain.", "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 certificate_chain.", "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/certificate_chainStatusObject" }, "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 certificate_chain.", "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 certificate_chain.", "maxLength": 1024, "x-f5xc-constraints": { "constraintType": "string", "category": "general", "maxLength": 1024, "metadata": { "source": "inferred", "confidence": 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 certificate_chain 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 certificate_chain 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 certificate_chainListResponseItem", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a certificate_chain", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.certificate_chain.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/certificate_chainReplaceSpecType" } ], "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 certificate_chainReplaceRequest", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.certificate_chain.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificate_chainReplaceResponse", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainReplaceSpecType": { "type": "object", "description": "Shape of the Certificate Chain specification.", "title": "Replace Certificate Chain", "x-displayname": "Replace Certificate Chain.", "x-ves-proto-message": "ves.io.schema.certificate_chain.ReplaceSpecType", "x-f5xc-description-short": "Shape of the Certificate Chain specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificate_chainReplaceSpecType", "required_fields": [], "mutually_exclusive_groups": [], "example_json": "{}", "example_yaml": "{}" }, "x-f5xc-cli-domain": "certificates", "x-f5xc-recommended-oneof-variant": { "ocsp_stapling_choice": "use_system_defaults" }, "x-f5xc-namespace-profile": { "constraint": { "allowed": [ "custom", "default", "shared" ], "enforced": true }, "recommendation": { "primary": "custom", "alternatives": [], "rationale": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "certificate_chainStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Status for Certificate Chain", "x-displayname": "Status", "x-ves-proto-message": "ves.io.schema.certificate_chain.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/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for certificate_chainStatusObject", "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": "Certificate chains can be managed in any namespace" }, "classification": { "category": "certificate", "multi_tenant_pattern": "per-tenant" } } }, "trusted_ca_listCreateRequest": { "type": "object", "description": "This is the input message of the 'Create' RPC.", "title": "CreateRequest is used to create an instance of trusted_ca_list", "x-displayname": "Create Request.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.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/trusted_ca_listCreateSpecType" } ], "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 trusted_ca_listCreateRequest", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listCreateResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.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/trusted_ca_listGetSpecType" } ], "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 trusted_ca_listCreateResponse", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listCreateSpecType": { "type": "object", "description": "Shape of the Root CA Certificate specification.", "title": "Create Root CA Certificate", "x-displayname": "Create Root CA Certificate.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.CreateSpecType", "properties": { "trusted_ca_url": { "type": "string", "description": "Trusted CA certificates for validating certificates.", "maxLength": 512000, "x-displayname": "Root CA Certificate.", "x-ves-example": "Cert", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512000", "ves.io.schema.rules.string.truststore_url": "true" }, "x-f5xc-example": "cert", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512000", "ves.io.schema.rules.string.truststore_url": "true" }, "x-f5xc-description-short": "Trusted CA certificates for validating certificates.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512000, "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": "Shape of the Root CA Certificate specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for trusted_ca_listCreateSpecType", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listDeleteRequest": { "type": "object", "description": "This is the input message of the 'DELETE' RPC.", "title": "DeleteRequest is used to delete a trusted_ca_list", "x-displayname": "DELETE Request.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.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 trusted_ca_listDeleteRequest", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listGetResponse": { "type": "object", "description": "This is the output message of the 'GET' RPC.", "title": "GetResponse is the shape of a read trusted_ca_list", "x-displayname": "GET Response.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.GetResponse", "properties": { "create_form": { "allOf": [ { "$ref": "#/components/schemas/trusted_ca_listCreateRequest" } ], "x-f5xc-description-short": "Configuration parameter for create form.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "deleted_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "deleted_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Deleted Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "disabled_referred_objects": { "type": "array", "description": "The set of deleted objects that are referred by this object.", "title": "disabled_referred_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Disabled Referred Objects.", "x-f5xc-description-short": "The set of deleted objects that are referred by this object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaObjectGetMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "referring_objects": { "type": "array", "description": "The set of objects that are referring to this object in their spec.", "title": "referring_objects", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Referring Objects.", "x-f5xc-description-short": "The set of objects that are referring to this object in their spec.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "replace_form": { "allOf": [ { "$ref": "#/components/schemas/trusted_ca_listReplaceRequest" } ], "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/trusted_ca_listGetSpecType" } ], "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/trusted_ca_listStatusObject" }, "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 trusted_ca_listGetResponse", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listGetSpecType": { "type": "object", "description": "Shape of the Root CA Certificate specification.", "title": "Get Root CA Certificate", "x-displayname": "GET Root CA Certificate.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.GetSpecType", "properties": { "infos": { "type": "array", "description": "Information about Trusted CA certificates.", "items": { "$ref": "#/components/schemas/schemaCertInfoType" }, "x-displayname": "Trusted CA Certificates Information.", "x-f5xc-description-short": "Information about Trusted CA certificates.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "trusted_ca_url": { "type": "string", "description": "Trusted CA certificates for validating certificates.", "maxLength": 512000, "x-displayname": "Root CA Certificate.", "x-ves-example": "Cert", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512000", "ves.io.schema.rules.string.truststore_url": "true" }, "x-f5xc-example": "cert", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512000", "ves.io.schema.rules.string.truststore_url": "true" }, "x-f5xc-description-short": "Trusted CA certificates for validating certificates.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512000, "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": "Shape of the Root CA Certificate specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for trusted_ca_listGetSpecType", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listListResponse": { "type": "object", "description": "This is the output message of 'List' RPC.", "title": "ListResponse is the collection of trusted_ca_list", "x-displayname": "List Response.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.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/trusted_ca_listListResponseItem" }, "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 trusted_ca_listListResponse", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listListResponseItem": { "type": "object", "description": "By default a summary of trusted_ca_list 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 trusted_ca_list", "x-displayname": "List Item", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.ListResponseItem", "properties": { "annotations": { "type": "object", "description": "The set of annotations present on this trusted_ca_list.", "title": "annotations", "x-displayname": "Annotations.", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of annotations present on this trusted_ca_list.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "description": { "type": "string", "description": "The description set for this trusted_ca_list.", "title": "description", "x-displayname": "Description.", "x-f5xc-description-short": "The description set for this trusted_ca_list.", "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 trusted_ca_list is administratively disabled.", "title": "disabled", "format": "boolean", "x-displayname": "Disabled", "x-f5xc-example": "True", "x-f5xc-description-short": "Value of true indicates trusted_ca_list is administratively disabled.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "get_spec": { "allOf": [ { "$ref": "#/components/schemas/trusted_ca_listGetSpecType" } ], "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "labels": { "type": "object", "description": "The set of labels present on this trusted_ca_list.", "title": "labels", "x-displayname": "Labels", "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-description-short": "The set of labels present on this trusted_ca_list.", "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 trusted_ca_list.", "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/trusted_ca_listStatusObject" }, "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 trusted_ca_list.", "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 trusted_ca_list 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 trusted_ca_list 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 trusted_ca_listListResponseItem", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listReplaceRequest": { "type": "object", "description": "This is the input message of the 'Replace' RPC.", "title": "ReplaceRequest is used to replace contents of a trusted_ca_list", "x-displayname": "Replace Request.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.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/trusted_ca_listReplaceSpecType" } ], "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 trusted_ca_listReplaceRequest", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listReplaceResponse": { "type": "object", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.ReplaceResponse", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for trusted_ca_listReplaceResponse", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listReplaceSpecType": { "type": "object", "description": "Shape of the Root CA Certificate specification.", "title": "Replace Root CA Certificate", "x-displayname": "Replace Root CA Certificate.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.ReplaceSpecType", "properties": { "trusted_ca_url": { "type": "string", "description": "Trusted CA certificates for validating certificates.", "maxLength": 512000, "x-displayname": "Root CA Certificate.", "x-ves-example": "Cert", "x-ves-validation-rules": { "ves.io.schema.rules.string.max_len": "512000", "ves.io.schema.rules.string.truststore_url": "true" }, "x-f5xc-example": "cert", "x-validation-rules": { "ves.io.schema.rules.string.max_len": "512000", "ves.io.schema.rules.string.truststore_url": "true" }, "x-f5xc-description-short": "Trusted CA certificates for validating certificates.", "x-f5xc-constraints": { "constraintType": "string", "category": "discovery", "maxLength": 512000, "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": "Shape of the Root CA Certificate specification.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for trusted_ca_listReplaceSpecType", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } }, "trusted_ca_listStatusObject": { "type": "object", "description": "Most recently observed status of object.", "title": "Trusted CA List Status", "x-displayname": "Status Object.", "x-ves-proto-message": "ves.io.schema.trusted_ca_list.StatusObject", "properties": { "conditions": { "type": "array", "description": "Conditions reported by various components of the system.", "title": "conditions", "items": { "$ref": "#/components/schemas/schemaConditionType" }, "x-displayname": "Conditions.", "x-f5xc-description-short": "Conditions reported by various components of the system.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/schemaStatusMetaType" } ], "x-f5xc-example": "{\"key\": \"value\"}", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } }, "object_refs": { "type": "array", "description": "Reference to object for current status.", "title": "object_refs", "items": { "$ref": "#/components/schemas/schemaObjectRefType" }, "x-displayname": "Config Object.", "x-f5xc-required-for": { "minimum_config": false, "create": false, "update": false, "read": false } } }, "x-f5xc-description-short": "Most recently observed status of object.", "x-f5xc-minimum-configuration": { "description": "Minimum configuration for trusted_ca_listStatusObject", "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": "shared", "alternatives": [], "rationale": "Trust anchors should be centralized for consistent TLS validation" }, "classification": { "category": "certificate", "multi_tenant_pattern": "shared-ref" } } } }, "responses": {}, "parameters": {}, "requestBodies": {} } }